Facility Navigation Bar Tool – Configuring the Initial Filter

Note: You can change configuration settings for this tool in Run mode. However, these settings usually only persist for the current runtime session. When you close the CygNet Studio screen on which the tool resides, the tool settings may revert to those originally configured in Edit mode. To learn how to override this behavior, see RuntimeCfgAutoPersist.

The Initial Filter property pre-filters facilities before returning facility data to the Facility Navigation Bar Tool. The drop-down levels only list facilities if they meet the Initial Filter criteria that you define.

Employing an Initial Filter improves search performance, as it allows searches to focus on a smaller subset of facilities. Irrelevant facilities are removed, so searches "drill down" to relevant ones more quickly. This is especially useful for a large Facility Service (FAC).

Creating Initial Filters is optional. If you specify just a SiteService and do not set up an Initial Filter, the Facility Navigation Bar Tool will return all facilities in the FAC.

This topic includes the following sections:

To learn more about the General page of the CygNet Facility Navigation Bar Control Properties dialog box or to find out more about configuring the Facility Navigation Bar Tool, see Configuring the Facility Navigation Bar Tool.

To Configure an Initial Filter

  1. In the CygNet Facility Navigation Bar Control Properties dialog box, click the General tab to display the following:

Facility Navigation Bar Control Properties

Facility Navigation Bar Control Properties
  1. Select the SiteService.
  2. To define attributes for the Initial Filter, click the Define Filter Attributes button to display the Edit Facility Navigation Bar Custom Attributes dialog box. Go to To Define Filter Attributes, below, to learn more.
  3. To define rules for the Initial Filter, click the … button next to the Initial Filter field to display the Set Initial Facility Rules dialog box:

Set Initial Facility Rules

Set Initial Facility Rules
  1. Click the Add button to display the Rule Definition dialog box.
  2. Use the options in the Rule Definition dialog box to configure the facility filter rules. For details, see the Using CygNet Filter Rules topic.

    3. Note: If you select the Reference Attribute option for the Comparison Type field, the Comparison Item field will list Facility Navigation Bar Custom Attributes. This includes the attributes you define using Define Filter Attributes. For details, see To Define Filter Attributes, below.

  1. When you finish defining a rule, click OK.
  2. If you want to compound rules, add another rule, then double-click the root of the rule tree in the Tree View of the Set Initial Facility Rules dialog box. The following dialog box appears:

Compound Rule Properties

Compound Rule Properties
  1. Select the Rule Evaluation that describes the rule logic you want to apply and click OK.
  2. When you finish configuring rules, click OK to save and close the Set Initial Facility Rules dialog box.
  3. In the CygNet Facility Navigation Bar Control Properties dialog box, change any other settings and click Apply. Click OK.

Back to top

To Define Filter Attributes

Note: You can use the following optional procedure to define custom facility attributes to include in a filter. One application of custom filter attributes is to specify one or more facilities that would not otherwise be included in the filter. You can either define filter attributes in Edit mode using the following procedure, or you can configure them dynamically at runtime using a script.

  1. Click the Define Filter Attributes button on the CygNet Facility Navigation Bar Control Properties dialog box to display the Edit Facility Navigation Bar Custom Attributes dialog box:

Facility Navigation Bar Custom Attributes

Facility Navigation Bar Custom Attributes
  1. Select the custom attribute you want to use with the Custom Attribute menu.
  2. In the Attribute Description field, type a description for the attribute you are configuring.
  3. If you want to include a specific attribute value in a rule as part of your filter, type it in the Attribute Value field. Otherwise, leave this field blank.
  4. Repeat steps 2 - 4 to add more custom attributes.
  5. When you finish, click OK.

    6. Any custom attributes you define will appear in the Facility Navigation Bar Custom Attributes list under the Comparison Item menu.

  6. To view the Facility Navigation Bar Custom Attributes list, display the Rule Definition dialog box, select the Reference Attribute option in the Comparison Type menu, then view the Comparison Item menu:

Comparison Item

Comparison Item

Back to top